home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / MrmOpenHierarchy.z / MrmOpenHierarchy
Encoding:
Text File  |  2003-11-18  |  9.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y - Allocates a hierarchy ID and opens    all
  10.       the UID files    in the hierarchy
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       #include <Mrm/MrmPublic.h>
  14.  
  15.       Cardinal MrmOpenHierarchy(nnnnuuuummmm____ffffiiiilllleeeessss,,,, ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt,,,,    aaaannnncccciiiillllllllaaaarrrryyyy____ssssttttrrrruuuuccccttttuuuurrrreeeessss____lllliiiisssstttt,,,, hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd)
  16.            _M_r_m_C_o_u_n_t           nnnnuuuummmm____ffffiiiilllleeeessss;
  17.            _S_t_r_i_n_g           ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt[];
  18.            _M_r_m_O_s_O_p_e_n_P_a_r_a_m_P_t_r   *aaaannnncccciiiillllllllaaaarrrryyyy____ssssttttrrrruuuuccccttttuuuurrrreeeessss____lllliiiisssstttt;
  19.            _M_r_m_H_i_e_r_a_r_c_h_y       *hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd;
  20.  
  21.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.       This routine is obsolete and exists for compatibility    with
  23.       previous releases.  It is replaced by
  24.       _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y_P_e_r_D_i_s_p_l_a_y.  _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y    is identical
  25.       to _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y_P_e_r_D_i_s_p_l_a_y    except that _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y
  26.       does not take    a ddddiiiissssppppllllaaaayyyy argument.
  27.  
  28.       nnnnuuuummmm____ffffiiiilllleeeessss
  29.            Specifies the number of files in    the name list.
  30.  
  31.       ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt
  32.            Specifies an array of character strings that identify
  33.            the UID files.
  34.  
  35.       aaaannnncccciiiillllllllaaaarrrryyyy____ssssttttrrrruuuuccccttttuuuurrrreeeessss____lllliiiisssstttt
  36.            A list of operating-system-dependent ancillary
  37.            structures corresponding    to such    things as filenames,
  38.            clobber flag, and so forth.  This argument should be
  39.            NULL for    most operations.  If you need to reference
  40.            this structure, see the definition of _M_r_m_O_s_O_p_e_n_P_a_r_a_m_P_t_r
  41.            in _M_r_m_P_u_b_l_i_c._h for more information.
  42.  
  43.       hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd
  44.            Returns the search hierarchy ID.     The search hierarchy
  45.            ID identifies the list of UID files that    MRM searches
  46.            (in order) when performing subsequent fetch calls.
  47.  
  48.       Each UID file    string in ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt can specify either a
  49.       full pathname    or a filename.    If a UID file string has a
  50.       leading slash    (/), it    specifies a full pathname, and MRM
  51.       opens    the file as specified.    Otherwise, the UID file    string
  52.       specifies a filename.     In this case MRM looks    for the    file
  53.       along    a search path specified    by the _U_I_D_P_A_T_H environment
  54.       variable or by a default search path,    which varies depending
  55.       on whether or    not the    _X_A_P_P_L_R_E_S_D_I_R environment    variable is
  56.       set.
  57.  
  58.       The _U_I_D_P_A_T_H environment variable specifies a search path and
  59.       naming conventions associated    with UID files.     It can
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.       contain the substitution field %U, where the UID file    string
  75.       from the ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt argument to
  76.       _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y_P_e_r_D_i_s_p_l_a_y is    substituted for    %U.  It    can
  77.       also contain the substitution    fields accepted    by
  78.       _X_t_R_e_s_o_l_v_e_P_a_t_h_n_a_m_e.  The substitution field %T    is always
  79.       mapped to _u_i_d.  The entire path is first searched with %S
  80.       mapped to ._u_i_d and then, if no file is found,    is searched
  81.       again    with %S    mapped to NULL.
  82.  
  83.       If no    display    is set prior to    calling    this function, the
  84.       result of this function's call to _X_t_R_e_s_o_l_v_e_P_a_t_h_n_a_m_e is
  85.       undefined.
  86.  
  87.       For example, the following _U_I_D_P_A_T_H value and
  88.       _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y call    cause MRM to open two separate UID
  89.       files:  UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L
  90.         static char    *uid_files[] = {"/usr/users/me/test.uid",
  91.       "test2"};
  92.         MrmHierarchy  *Hierarchy_id;
  93.         MrmOpenHierarchy((MrmCount)2,uid_files, NULL,
  94.       Hierarchy_id)
  95.  
  96.       MRM opens the    first file, /_u_s_r/_u_s_e_r_s/_m_e/_t_e_s_t._u_i_d, as
  97.       specified in the ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt argument to
  98.       _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y, because the    UID file string    in the
  99.       ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt argument specifies a full pathname.  MRM
  100.       looks    for the    second file, _t_e_s_t_2, first as
  101.       /_u_i_d_l_i_b/%_L/_t_e_s_t_2._u_i_d and second as /_u_i_d_l_i_b/_t_e_s_t_2/%_L, where
  102.       the display's    language string    is substituted for %L.
  103.  
  104.       After    _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y opens the UID hierarchy, you should
  105.       not delete or    modify the UID files until you close the UID
  106.       hierarchy by calling _M_r_m_C_l_o_s_e_H_i_e_r_a_r_c_h_y.
  107.  
  108.       If _U_I_D_P_A_T_H is    not set    but the    environment variable
  109.       _X_A_P_P_L_R_E_S_D_I_R is set, MRM searches the following pathnames:
  110.             22:59:55S
  111.             $XAPPLRESDIR/%L/uid/%N/22:59:55S
  112.             $XAPPLRESDIR/%l/uid/%N/22:59:55S
  113.             $XAPPLRESDIR/uid/%N/22:59:55S
  114.             $XAPPLRESDIR/%L/uid/22:59:55S
  115.             $XAPPLRESDIR/%l/uid/22:59:55S
  116.             $XAPPLRESDIR/uid/22:59:55S
  117.             $HOME/uid/22:59:55S
  118.             $HOME/22:59:55S
  119.             /usr/lib/X11/%L/uid/%N/22:59:55S
  120.             /usr/lib/X11/%l/uid/%N/22:59:55S
  121.             /usr/lib/X11/uid/%N/22:59:55S
  122.             /usr/lib/X11/%L/uid/22:59:55S
  123.             /usr/lib/X11/%l/uid/22:59:55S
  124.             /usr/lib/X11/uid/22:59:55S
  125.             /usr/include/X11/uid/22:59:55S
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  137.  
  138.  
  139.  
  140.       If neither _U_I_D_P_A_T_H nor _X_A_P_P_L_R_E_S_D_I_R is    set, MRM searches the
  141.       following pathnames:
  142.             22:59:55S
  143.             $HOME/%L/uid/%N/22:59:55S
  144.             $HOME/%l/uid/%N/22:59:55S
  145.             $HOME/uid/%N/22:59:55S
  146.             $HOME/%L/uid/22:59:55S
  147.             $HOME/%l/uid/22:59:55S
  148.             $HOME/uid/22:59:55S
  149.             $HOME/22:59:55S
  150.             /usr/lib/X11/%L/uid/%N/22:59:55S
  151.             /usr/lib/X11/%l/uid/%N/22:59:55S
  152.             /usr/lib/X11/uid/%N/22:59:55S
  153.             /usr/lib/X11/%L/uid/22:59:55S
  154.             /usr/lib/X11/%l/uid/22:59:55S
  155.             /usr/lib/X11/uid/22:59:55S
  156.             /usr/include/X11/uid/22:59:55S
  157.  
  158.       These    paths are defaults that    vendors    may change.  For
  159.       example, a vendor may    use different directories for
  160.       /_u_s_r/_l_i_b/_X_1_1 and /_u_s_r/_i_n_c_l_u_d_e/_X_1_1.
  161.  
  162.       The following    substitutions are used in these    paths:
  163.  
  164.       %_U   The UID file string, from the ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt argument.
  165.  
  166.       %_N   The class name of the application.
  167.  
  168.       %_L   The display's language string.
  169.  
  170.       %_l   The language component of the display's language
  171.            string.
  172.  
  173.       %_S   The suffix to the file name.  The entire    path is
  174.            searched    first with a suffix of ._u_i_l, and if no file is
  175.            found, it is searched again with    a NULL suffix.
  176.  
  177.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  178.       This function    returns    one of these status return constants:
  179.  
  180.       _M_r_m_S_U_C_C_E_S_S
  181.            The function executed successfully.
  182.  
  183.       _M_r_m_N_O_T__F_O_U_N_D
  184.            File not    found.
  185.  
  186.       _M_r_m_F_A_I_L_U_R_E
  187.            The function failed.
  188.  
  189.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  190.       _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y_P_e_r_D_i_s_p_l_a_y(_3_X) and _M_r_m_C_l_o_s_e_H_i_e_r_a_r_c_h_y(_3_X).
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 11/11/03)
  196.  
  197.  
  198.  
  199.